HeaderProvider

fun fun interface HeaderProvider : RequestHandler

An object or lambda that provides some headers.

Functions

canHandleAuthentication

open fun canHandleAuthentication(response: HttpResponse): Boolean

If this returns true, handleAuthentication must be implemented.

handleAuthentication

open suspend fun handleAuthentication(client: HttpClient, url: URL, data: Any, options: <ERROR CLASS>): HttpResponse

Will not be called unless canHandleAuthentication is true.

headers

abstract fun MutableHeaders.headers()

plus

open operator fun plus(other: HeaderProvider): HeaderProvider

prepareRequest

open override fun <ERROR CLASS>.prepareRequest(headers: MutableHeaders)

Modify an outgoing request.

Inheritors

BasicAuthHandler

BearerAuthHandler

PersonalAccessTokenAuthHandler

Extensions

toMap

fun HeaderProvider.toMap(): Map<String, String>

Sources

js source